dxp-ux
GET logicalResource (TMF 639)
This endpoint validates the phone number and returns if the phone number is active or not.
URL
http://[localhost]:[port]/dxp-ux/v1/{businessId}/logicalResourceURL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (PA) identifying the business unit. | Y |
Headers
| name | type | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
Query Params
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| @type | string | Type of logical resource Possible Value for PA: MSISDN | Y |
| value | string | The value of the logical resource Example: '50769877689' | Y |
| limit | integer | Requested number of resources to be provided in response Example: 1 | Y |
Data Model - Response
| field name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| id | string | Unique identifier of the logicalResource | Y (PA) |
| href | string | Reference to the logicalResource | Y (PA) |
| name | string | Name of the resource | Y (PA) |
| description | string | description of the resource | Y (PA) |
| value | string | value of the logical resource | Y (PA) |
| category | string | Indicates the category of the number | Y (PA) |
| administrativeState | string | A resource administrative state type such as NoState, Active, Administrative, Aging, Available, HoldForLoading, HoldForOrderCompletion, HoldForOrderCompletion_OverLimit, HoldForOrderSubmission, Reserved, WaitingPurge, HoldForSelection, OnIntercept, Donated, PortedOut, Reserved_OverLimit, Resold_Carrier, Resold_NonCarrierAssigned, Resold_NonCarrierUnassigned, Barred, TestNumbers, Employee_OfficialNumbers, LocationRoutingNumbers, TemporaryLocalDirectoryNumbers, ESRD_ESRK | Y (PA) |
| resourceStatus | string | A resource status type such as standby,reserved, suspended, active, available | Y (PA) |
| operationalState | string | A resource operational state type such as enable, disable . | Y (PA) |
| note[] | array | Extra information about a given entity | Y (PA) |
| note[].text | string | Text of the note | Y (PA) |
| resourceCharacteristic[] | array | Describes a given characteristic of an object or entity through a name/value pair. | Y (PA) |
| resourceCharacteristic[].name | string | Name of the characteristic | Y (PA) |
| resourceCharacteristic[].valueType | string | Data type of the value of the characteristic | Y (PA) |
| resourceCharacteristic[].value | any | The value of the characteristic | Y (PA) |
| resourceRelationship[] | array | Linked resources to the one instantiate | Y (PA) |
| resourceRelationship[].relationshipType | string | relationship type of the resources. Here it is "reliesOn" | Y (PA) |
| resourceRelationship[].resource | object | Resource is an abstract entity that describes the common set of attributes shared by all concrete resources. | Y (PA) |
| resourceRelationship[].resource.id | string | Identifier of an instance of the resource. | Y (PA) |
| resourceRelationship[].resource.description | string | description of the resource | Y (PA) |
| @type | string | When sub-classing, this defines the sub-class Extensible name | Y (PA) |
resourceCharacteristic subResource - dataModel
| resource characteristic name | type | description | required(mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| PortDetails | array | It provides details of the port such as port type, foreign number status, and previous service provider | Y (PA) | PA: [ { "name": "portOldSp", "valueType": "string", "value": "198"}, { "name": "portType","valueType": "string", "value": "NotPorted" }, {"name": "foreignNumber", "valueType": "boolean","value": "N" }] |
| DataType | string | Specifies the type of data plan associated with the number | Y (PA) | PA: { "name": "DataType", "valueType": "string", "value": "PREPAID" } |
| Dealer Code | string | Indicates the dealer code assigned to the number by the service provider | Y (PA) | PA: { "name": "Dealer Code", "valueType": "string", "value": "52" } |
| Number Category | string | Indicates the category of the number | Y (PA) | PA: { "name": "Number Category", "valueType": "string", "value": "Normal" } |
| SERVICE | string | Indicates whether the current service is Prepaid or Postpaid | Y (PA) | PA: { "name": "SERVICE", "valueType": "string", "value": "PREPAID" } |
| SDP | string | Indicates the Service Data Point (SDP) responsible for service management or rating | Y (PA) | PA: { "name": "SDP", "valueType": "string", "value": "01" } |
| SERVICE-ORIGINAL | string | Indicates the original service type at the time of provisioning or activation | Y (PA) | PA: { "name": "SERVICE-ORIGINAL", "valueType": "string", "value": "PREPAID" } |
| PREPAID-DEALER | string | Indicates the name or type of dealer originally associated with prepaid activation | Y (PA) | PA: { "name": "PREPAID-DEALER", "valueType": "string", "value": "General" } |
| RECYCLE | string | Indicates whether the number is part of the number recycling process | Y (PA) | PA: { "name": "RECYCLE", "valueType": "string", "value": "Y" } |
Note: The list of resourceCharacteristics completely depends on the TNM system response. Whatever userDataList retrieved from TNM system are mapped in the resource characteristics.
resourceCharacteristic[].name=='PortDetails' subResource - dataModel
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| portOldSp | string | The old service provider ID or code | Y (PA) | PA: { "name": "portOldSp", "valueType": "string", "value": "198" } |
| portType | string | Indicates the type of port | Y (PA) | PA: { "name": "portType", "valueType": "string", "value": "NotPorted" } |
| foreignNumber | string | Indicates whether this number is native to the service provider or belongs to another provider. | Y (PA) | PA: { "name": "foreignNumber", "valueType": "boolean", "value": "N" } |
Key considerations
PA Implementation
- This is implemented for mobile prepaid and postpaid customers.
- The '@type' input query parameter should be "MSISDN".
- The 'value' (MSISDN/ServiceNo) input query parameter should be provided with BU code(507). Example: 50769877689
- The 'limit' input query parameter should always be "1".
- The list of resourceCharacteristics in the response varies based on the userDataType, userDataValue fields retrieved in userDataList from TNM system response.
- Please refer the responses in following URL DXP UX API - list logicalResource